xref: /petsc/src/mat/impls/transpose/transm.c (revision fc8a9adeb7fcdc98711d755fa2dc544ddccf0f3e)
1 
2 #include <petsc/private/matimpl.h>          /*I "petscmat.h" I*/
3 
4 typedef struct {
5   Mat A;
6 } Mat_Transpose;
7 
8 PetscErrorCode MatMult_Transpose(Mat N,Vec x,Vec y)
9 {
10   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
11   PetscErrorCode ierr;
12 
13   PetscFunctionBegin;
14   ierr = MatMultTranspose(Na->A,x,y);CHKERRQ(ierr);
15   PetscFunctionReturn(0);
16 }
17 
18 PetscErrorCode MatMultAdd_Transpose(Mat N,Vec v1,Vec v2,Vec v3)
19 {
20   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
21   PetscErrorCode ierr;
22 
23   PetscFunctionBegin;
24   ierr = MatMultTransposeAdd(Na->A,v1,v2,v3);CHKERRQ(ierr);
25   PetscFunctionReturn(0);
26 }
27 
28 PetscErrorCode MatMultTranspose_Transpose(Mat N,Vec x,Vec y)
29 {
30   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
31   PetscErrorCode ierr;
32 
33   PetscFunctionBegin;
34   ierr = MatMult(Na->A,x,y);CHKERRQ(ierr);
35   PetscFunctionReturn(0);
36 }
37 
38 PetscErrorCode MatMultTransposeAdd_Transpose(Mat N,Vec v1,Vec v2,Vec v3)
39 {
40   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
41   PetscErrorCode ierr;
42 
43   PetscFunctionBegin;
44   ierr = MatMultAdd(Na->A,v1,v2,v3);CHKERRQ(ierr);
45   PetscFunctionReturn(0);
46 }
47 
48 PetscErrorCode MatDestroy_Transpose(Mat N)
49 {
50   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
51   PetscErrorCode ierr;
52 
53   PetscFunctionBegin;
54   ierr = MatDestroy(&Na->A);CHKERRQ(ierr);
55   ierr = PetscObjectComposeFunction((PetscObject)N,"MatTransposeGetMat_C",NULL);CHKERRQ(ierr);
56   ierr = PetscFree(N->data);CHKERRQ(ierr);
57   PetscFunctionReturn(0);
58 }
59 
60 PetscErrorCode MatDuplicate_Transpose(Mat N, MatDuplicateOption op, Mat* m)
61 {
62   Mat_Transpose  *Na = (Mat_Transpose*)N->data;
63   PetscErrorCode ierr;
64 
65   PetscFunctionBegin;
66   if (op == MAT_COPY_VALUES) {
67     ierr = MatTranspose(Na->A,MAT_INITIAL_MATRIX,m);CHKERRQ(ierr);
68   } else if (op == MAT_DO_NOT_COPY_VALUES) {
69     ierr = MatDuplicate(Na->A,MAT_DO_NOT_COPY_VALUES,m);CHKERRQ(ierr);
70     ierr = MatTranspose(*m,MAT_INPLACE_MATRIX,m);CHKERRQ(ierr);
71   } else SETERRQ(PetscObjectComm((PetscObject)N),PETSC_ERR_SUP,"MAT_SHARE_NONZERO_PATTERN not supported for this matrix type");
72   PetscFunctionReturn(0);
73 }
74 
75 PetscErrorCode MatCreateVecs_Transpose(Mat A,Vec *r, Vec *l)
76 {
77   Mat_Transpose  *Aa = (Mat_Transpose*)A->data;
78   PetscErrorCode ierr;
79 
80   PetscFunctionBegin;
81   ierr = MatCreateVecs(Aa->A,l,r);CHKERRQ(ierr);
82   PetscFunctionReturn(0);
83 }
84 
85 PetscErrorCode MatAXPY_Transpose(Mat Y,PetscScalar a,Mat X,MatStructure str)
86 {
87   Mat_Transpose  *Ya = (Mat_Transpose*)Y->data;
88   Mat_Transpose  *Xa = (Mat_Transpose*)X->data;
89   Mat              M = Ya->A;
90   Mat              N = Xa->A;
91   PetscErrorCode ierr;
92 
93   PetscFunctionBegin;
94   ierr = MatAXPY(M,a,N,str);CHKERRQ(ierr);
95   PetscFunctionReturn(0);
96 }
97 
98 PetscErrorCode MatTransposeGetMat_Transpose(Mat A,Mat *M)
99 {
100   Mat_Transpose  *Aa = (Mat_Transpose*)A->data;
101 
102   PetscFunctionBegin;
103   *M = Aa->A;
104   PetscFunctionReturn(0);
105 }
106 
107 /*@
108       MatTransposeGetMat - Gets the Mat object stored inside a MATTRANSPOSEMAT
109 
110    Logically collective on Mat
111 
112    Input Parameter:
113 .   A  - the MATTRANSPOSE matrix
114 
115    Output Parameter:
116 .   M - the matrix object stored inside A
117 
118    Level: intermediate
119 
120 .seealso: MatCreateTranspose()
121 
122 @*/
123 PetscErrorCode MatTransposeGetMat(Mat A,Mat *M)
124 {
125   PetscErrorCode ierr;
126 
127   PetscFunctionBegin;
128   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
129   PetscValidType(A,1);
130   PetscValidPointer(M,2);
131   ierr = PetscUseMethod(A,"MatTransposeGetMat_C",(Mat,Mat*),(A,M));CHKERRQ(ierr);
132   PetscFunctionReturn(0);
133 }
134 
135 /*@
136       MatCreateTranspose - Creates a new matrix object that behaves like A'
137 
138    Collective on Mat
139 
140    Input Parameter:
141 .   A  - the (possibly rectangular) matrix
142 
143    Output Parameter:
144 .   N - the matrix that represents A'
145 
146    Level: intermediate
147 
148    Notes:
149     The transpose A' is NOT actually formed! Rather the new matrix
150           object performs the matrix-vector product by using the MatMultTranspose() on
151           the original matrix
152 
153 .seealso: MatCreateNormal(), MatMult(), MatMultTranspose(), MatCreate()
154 
155 @*/
156 PetscErrorCode  MatCreateTranspose(Mat A,Mat *N)
157 {
158   PetscErrorCode ierr;
159   PetscInt       m,n;
160   Mat_Transpose  *Na;
161 
162   PetscFunctionBegin;
163   ierr = MatGetLocalSize(A,&m,&n);CHKERRQ(ierr);
164   ierr = MatCreate(PetscObjectComm((PetscObject)A),N);CHKERRQ(ierr);
165   ierr = MatSetSizes(*N,n,m,PETSC_DECIDE,PETSC_DECIDE);CHKERRQ(ierr);
166   ierr = PetscLayoutSetUp((*N)->rmap);CHKERRQ(ierr);
167   ierr = PetscLayoutSetUp((*N)->cmap);CHKERRQ(ierr);
168   ierr = PetscObjectChangeTypeName((PetscObject)*N,MATTRANSPOSEMAT);CHKERRQ(ierr);
169 
170   ierr       = PetscNewLog(*N,&Na);CHKERRQ(ierr);
171   (*N)->data = (void*) Na;
172   ierr       = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
173   Na->A      = A;
174 
175   (*N)->ops->destroy          = MatDestroy_Transpose;
176   (*N)->ops->mult             = MatMult_Transpose;
177   (*N)->ops->multadd          = MatMultAdd_Transpose;
178   (*N)->ops->multtranspose    = MatMultTranspose_Transpose;
179   (*N)->ops->multtransposeadd = MatMultTransposeAdd_Transpose;
180   (*N)->ops->duplicate        = MatDuplicate_Transpose;
181   (*N)->ops->getvecs          = MatCreateVecs_Transpose;
182   (*N)->ops->axpy             = MatAXPY_Transpose;
183   (*N)->assembled             = PETSC_TRUE;
184 
185   ierr = PetscObjectComposeFunction((PetscObject)(*N),"MatTransposeGetMat_C",MatTransposeGetMat_Transpose);CHKERRQ(ierr);
186   ierr = MatSetBlockSizes(*N,PetscAbs(A->cmap->bs),PetscAbs(A->rmap->bs));CHKERRQ(ierr);
187   ierr = MatSetUp(*N);CHKERRQ(ierr);
188   PetscFunctionReturn(0);
189 }
190 
191